/*
 * Copyright 2009 eBusinessInformation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.excilys.ymca.task;

import java.io.File;


/**
 * Bean permettant à {@link UpdateApplicationTask} de transmettre un résultat
 * entre {@link UpdateApplicationTask#doInBackground(Integer...)} et
 * {@link UpdateApplicationTask#onPostExecute(UpdateTaskResult)}
 * 
 * @author Pierre-Yves Ricau ( py.ricau+ymca @ gmail.com )
 */
public class UpdateTaskResult {

    private final Exception exception;

    private final boolean   upToDate;

    private final File      downloadedFile;

    private UpdateTaskResult(Exception exception, boolean upToDate, File downloadedFile) {
        this.exception = exception;
        this.upToDate = upToDate;
        this.downloadedFile = downloadedFile;
    }

    public Exception getException() {
        return exception;
    }

    public boolean isUpToDate() {
        return upToDate;
    }

    public File getDownloadedFile() {
        return downloadedFile;
    }

    /**
     * Factory method
     */
    public static UpdateTaskResult exception(Exception e) {
        return new UpdateTaskResult(e, false, null);
    }

    /**
     * Factory method
     */
    public static UpdateTaskResult upToDate() {
        return new UpdateTaskResult(null, true, null);
    }

    /**
     * Factory method
     */
    public static UpdateTaskResult updateAvailable(File downloadedFile) {
        return new UpdateTaskResult(null, false, downloadedFile);
    }

}
